docs: correct pages describing a pre-1.44 UI, and gate image hygiene - #140
Merged
Merged
Conversation
Nine sections documented controls that 1.44 replaced, so following them led somewhere that no longer exists. Verified against the v1.44.0 tag rather than the changelog. - events: the raw Event Type / Event Subtype dropdowns are now one Action picker, grouped by intent with a direction badge and a Recent group. The common-customization list now names the action to pick instead of a type/subtype pair. - events: the issue button is an actions center. It counts categories rather than items and lists every category, including empty ones. Split into its own page, since events.md was already at the 500-line cap. - assets: the status dropdown is gone; ignored handling is a filter pill. - balances: the tag selector is a pill inside the bar, not a textbox above it. - accounts: the chain selector is a full pill bar with saved views and multi-account filtering, and an older bookmarked filter link no longer restores. - blockchain: the API key section was wrong in both directions. Blockscout's multichain endpoints now reject keyless requests, so it needs a key everywhere except Hyperliquid, and Routescan only covers Ethereum and Optimism. Gnosis, Scroll and Binance SC each need a specific key. - interface: the alias priority list gained the opt-in GNS names source. - quick-start: account creation starts with a mode chooser.
Loopring tracking was removed in 1.44 after the Loopring API shut down, but the docs still walked users through exporting a Loopring API key and adding it to a section the app no longer has. Replace the setup guide with a note that the integration is gone and that existing historical Loopring data is preserved, and delete the three screenshots it owned.
Nothing checked images, which is why 13 unreferenced ones had accumulated and why two sets had drifted out of the directory that mirrors their page. The convention only survives if something enforces it. Add scripts/check-images.mjs, wired in as pnpm run check:images and a CI step. It fails on three things: a reference that resolves to no file, an image nothing references, and an image sitting outside its page's directory (_shared/ and _external/ excepted). Then fix what it found: - delete 16 unreferenced images, 13 pre-existing and 3 orphaned by retiring the Loopring guide. That leaves the corpus entirely webp. - move the three referral screenshots under premium/referrals/ and the chains screenshot under settings/blockchain/, matching the pages that use them. Also correct the Address Book heading so the app's importAddressBook deep link resolves. It pointed at #importing-address-book-names-csv while the heading rendered #import-multiple-address-books-csv, so the in-app link had been landing on the page top.
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
First of three PRs catching the docs up to 1.44. This one is the corrections
only: nine places where the prose described a control that 1.44 replaced, so
following the docs led somewhere that no longer exists. No new features are
documented here (that is PR 2) and no screenshots are refreshed (PR 3).
Everything was verified against the
v1.44.0tag rather than against thechangelog. Two things came out different from what the changelog implied, both
noted below.
Corrections
history/eventsEvent Type/Event SubtypedropdownsActionpicker, grouped by intent, with a direction badge and a Recent grouphistory/eventsdata-management/assetsportfolio/balancesportfolio/accountssettings/blockchainsettings/interfacequick-startintegrations/external-servicesThe API key section was wrong in both directions
This is the one worth a close look. The changelog only mentions Gnosis, but
the backend at
v1.44.0says more:reject keyless requests with 401/402 (
externalapis/blockscout.py), so theold line "Blockscout does not require an API key" was simply false. The one
exception is Hyperliquid, served through a free public instance.
ROUTESCAN_SUPPORTED_CHAINS).Arbitrum One and Base are commented out as having an unusable status, so
Routescan was not the free fallback the docs implied for other chains.
and leaves Gnosis (Blockscout key or paid Etherscan), Scroll (Blockscout
key) and Binance SC (paid Etherscan) each needing something specific.
Blockscout limit.
Action picker vocabulary
The verb labels are backend data (
accounting/constants.py), not thechangelog's approximate "Trade, Transfer, DeFi, Staking, etc.". The
common-customization list now names real actions (
account deposit,bridge out,protocol withdrawal,stake,migrate) and the group listuses the 16 real labels.
Page split
usage-guides/history/events.mdwas already at 488 lines against the repo's500-line cap, and the actions center rewrite pushed it over. Rather than trim
the content, the Resolving Issues section moved to its own page,
usage-guides/history/issues.md(events.md is now 370, issues.md 176). Addedto the sidebar; the one inbound anchor in
tax-accounting/guide.mdisupdated.
Checked first that nothing in the app deep-links into it:
external-links.tsat
v1.44.0references nohistory/eventsanchor at all.Image hygiene gate
Nothing checked images, which is why 13 unreferenced ones had accumulated and
why two sets had drifted out of the directory mirroring their page. Added
scripts/check-images.mjs, wired in aspnpm run check:imagesand a CI step.It fails on a reference resolving to no file, an image nothing references, and
an image outside its page's directory (
_shared/and_external/excepted).Then fixed what it found:
retiring the Loopring guide. The corpus is now entirely webp.
premium/referrals/and thechains screenshot under
settings/blockchain/.One unrelated fix
The app's
importAddressBooklink points atdata-management/address-book#importing-address-book-names-csv, but theheading rendered
#import-multiple-address-books-csv, so that in-app link hasbeen landing on the page top. Fixed on the docs side rather than in the app,
since 1.44 is already released and nothing else linked to the old anchor.
Verification
pnpm run lint,pnpm run check:imagesandpnpm run buildall clean.VitePress dead-link checking is on by default and the build passes.
Still owed, deliberately not here
The screenshots this PR's text now contradicts are untouched:
issue_check_button.webpstill shows the pre-actions-center button, and theevent form screenshots still show the old dropdowns. Those are PR 3, which
needs a demo build off the
v1.44.0tag.